home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / dfÜ / gotcha / docs / gtools.doc < prev    next >
Encoding:
Text File  |  1996-03-30  |  19.6 KB  |  681 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                     GTools
  7.  
  8.  
  9.                                    Version
  10.                                      1.1
  11.  
  12.  
  13.  
  14.  
  15.                                 Thomas Bickel
  16.  
  17.  
  18.  
  19.                                   1995/1996
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                          Generated with Heddley v1.1
  37.                       Heddley v1.1 (C) Edd Dumbill 1994
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.                                   - Page 1 -
  77.  
  78.  
  79.  
  80. 1.    Gotcha Tools Documentation
  81.  
  82.  
  83.  
  84.                          Gotcha Tools Documentation
  85.  
  86.  
  87.            Copyright 1995/1996 Thomas Bickel; All rights reserved.
  88.  
  89.  
  90.    GList             The nodelist compiler
  91.    GetInfo           Get and search the nodelist for informations
  92.    GTell             Send ARexx commands
  93.    ShowXConfig       Show custom configuration entries
  94.    GPoll             Gotchas call scheduler
  95.    Trap2G            Convert Trapdoor to Gotcha configurations
  96.    GFReq             Gotchas little file request helper
  97.    GConfig           Gotchas configuration tool
  98.  
  99.    Legal stuff
  100.  
  101. 2.    GList
  102.  
  103.  
  104.  
  105.  
  106.    Basics         What do you need it for
  107.    Usage          How to use and config it
  108.  
  109. 3.    GList Basics
  110.  
  111.  
  112.    GList is Gotchas nodelist compiler. If you want to call nodes by telling
  113.    Gotcha the address (zone:net/node.point) rather than the phonenumber, or
  114.    if you want to have custom configurations than you will need to compile
  115.    a nodelist (or several if you want) with GList so Gotcha can access
  116.    the data stored therein.
  117.    Acctualy if you are a node and want to stay sane you should use it,
  118.    points don't realy need to but of course it works for points too.
  119.  
  120.  
  121.    What is a nodelist
  122.  
  123.    A nodelist is a text file that contains a list of all, or a part of all
  124.    nodes of a network (e.g FidoNet, AmigaNet). For each node it holds
  125.    informations such as the phonenumber, BBS name, sysop, etc.
  126.  
  127.  
  128.    What is a nodediff
  129.  
  130.    A nodediff is a text file that contains changes for a specific nodelist.
  131.  
  132. 4.    GList Usage
  133.  
  134.  
  135.    GList VERBOSE/S,UPDATE/S,CONFIG
  136.  
  137.    If you have specified the CONFIG keyword GList is going to try to open
  138.    the specified file else GList will look for it's config file
  139.    'GList.config' first in the current directory and if not found there in
  140.    'mail:' and then in 'nodelist:'.
  141.  
  142.    Options:
  143.    VERBOSE  .. print out some more information on what's happening
  144.    UPDATE   .. only update the password, cost, dial, setconfig information
  145.                from the config file, not compile the nodelist.
  146.  
  147.                                   - Page 2 -
  148. 4.    GList Usage
  149.  
  150.    CONFIG   .. (path and) name of the config file. If your config is not
  151.                named 'glist.config' or if you want to place it somewhere
  152.                else than the current directory, mail: or nodelist: then
  153.                use this one.
  154.  
  155.    If you need to use a ';' somewhere as a configuration you must escape
  156.    it with an backslash. The same is true for backslashes.
  157.  
  158.    Configuration commands (from v1.2 on the order is no longer important):
  159.  
  160.    nodelistpath <path>
  161.       This tells GList where the nodelist(s) can be found and where to put
  162.    its own files.
  163.    Example: nodelistpath "nodelist:"
  164.  
  165.  
  166.    deloldlists yes/no
  167.       Specifies wether old nodelists should be deleted after a nodediff was
  168.    applied to it.
  169.    Example: deloldlists yes
  170.  
  171.  
  172.    delolddiffs yes/no
  173.       Specifies wether old nodediffs should be deleted after they have been
  174.    applied to a nodelist.
  175.    Example: delolddiffs yes
  176.  
  177.  
  178.    zone <number>
  179.       Default zone number for nodelists without zone informations.
  180.    Example: zone 2
  181.  
  182.  
  183.    report <filename>
  184.       Specifies the file to save comments from the nodelist in.
  185.    Example: report "ram:fidoreport.txt"
  186.  
  187.  
  188.    comment <characters>
  189.       When parsing the nodelist and GList encounters a comment the line
  190.    will be stored in the report file if the comment-identifier (the 2nd
  191.    character in the line) was specified in <characters>.
  192.  
  193.    Comment-identifiers:
  194.    ;S This comment is of particular interest to Sysops.
  195.    ;U This comment is of particular interest to BBS users.
  196.    ;F This comment should appear in any formatted "Fido List".
  197.    ;A This comment is of general interest (shorthand for ;SUF).
  198.    ;E This comment is an error message inserted by MakeNL
  199.    ; This comment may be ignored by a nodelist processor.
  200.  
  201.    Example: comment SUA
  202.  
  203.  
  204.    nodelist <nodelist> diff <nodediff> domain <domain>
  205.       This specifies the name (without extension!) of the nodelist file,
  206.    the name of the belonging diff file and the domain of the nodelist.
  207.    The nodelists will be compiled in the order specified in the config file,
  208.    it is important to put pointlists (and alike lists) at the end!
  209.    Examples: nodelist "NODELIST" diff "NODEDIFF" domain "fidonet"
  210.              nodelist "AMYLIST"  diff "AMYDIFF"  domain "amiganet"
  211.              nodelist "POINT4D"  diff ""         domain "fidonet"
  212.  
  213.    password <password> <node> [<node> ... ]
  214.       Set sets up a password for (a) certain node(s). If calling out Gotcha
  215.    will fetch the password and send it out. On incoming calls it will
  216.    check wether the remotes password matches the one you set up, if not
  217.  
  218.                                   - Page 3 -
  219. 4.    GList Usage
  220.  
  221.    Gotcha will hang up.
  222.  
  223.    Example: password "abcdef" 39:23/5@amiganet 2:310/108@fidonet
  224.  
  225.  
  226.    dial <original string> <replacement string>
  227.       Specifies a phonenumber translation. Phonenumbers are stored in
  228.    international format in the nodelist. In order to be able to use them
  229.    you will need to specify some dial statements. When Gotcha looks up a
  230.    node to the nodelist it will search the translation table for a match
  231.    and replace <original string> with <replacement string>.
  232.    Examples: dial    "43-2252-"      "905-"
  233.              dial    "43-2682-"      "998-"
  234.  
  235.  
  236.    cost <cost> <phonenumber prefix>
  237.       Specifies cost per minute for the set of phonenumbers that have
  238.    <phonenumber prefix> in common. When Gotcha calls a node and there
  239.    is a cost specified it will be able to show the total cost for that
  240.    call. If you specify '-1' as cost this number will never be called.
  241.    Examples: cost    67      "43-2250"
  242.              cost    67      "43-2251"
  243.              cost    1330    "213-"
  244.  
  245.  
  246.    setconfig <address> [.<nodelist flag>.] <config string>
  247.       Specifies a custom configuration for a single node or all nodes
  248.    matching the address-pattern.
  249.  
  250.    It is also possible to set a custom configuration depending on the
  251.    nodelist flags. Say you want to set a config for all nodes with
  252.    the ISDN flag, write 'setconfig * .ISDN. <desired config>'.
  253.    Note that in the previous example the config will get set if the
  254.    string ISDN is found SOMEWHERE in the flags, ie ISDNC, ISDNX or FOOISDN
  255.    would also cause the config to be set.
  256.    To avoid this behaviour add a ',' to the string to be matched.
  257.    'setconfig * .,ISDNC,. <config>' will make Gotcha set the config only
  258.    if ISDNC is found.
  259.    'setconfig * .,ISDN. <config>' will make Gotcha set the config only if
  260.    a flag is found which starts with ISDN (ie ISDNC, ISDNFOO).
  261.    'setconfig * .ISDN,. <config>' will make Gotcha set the config only if
  262.    a flags is found that ends with ISDN (ie FOOISDN, BARISDN).
  263.  
  264.    It is also possible to specify mutiply nodelist flags.
  265.    'setconfig 2:* .,FOO,.,BAR,. <config>' will cause the config to be set
  266.    if the address is in zone 2 and FOO is a nodelist flag and BAR is a
  267.    nodelist flag of that address.
  268.  
  269.    Examples: setconfig 39:* AFTERSESSION "s:amiganet.bat"
  270.              setconfig 40:* AFTERSESSION "s:amiganet.bat"
  271.              setconfig 41:* AFTERSESSION "s:amiganet.bat"
  272.  
  273.  
  274.  ;--------------- example configuration -----------------------------------
  275.  
  276.  nodelistpath "nodelist:"
  277.  
  278.  deloldlists yes
  279.  delolddiffs yes
  280.  
  281.  zone 2
  282.  
  283.  report "ram:fidoreport.txt"
  284.  comment SUA
  285.  nodelist "NODELIST"     diff "NODEDIFF" domain "fidonet"
  286.  report "ram:amyreport.txt"
  287.  nodelist "AMYLIST"      diff "AMYDIFF"  domain "amiganet"
  288.  
  289.                                   - Page 4 -
  290. 4.    GList Usage
  291.  
  292.  report "ram:pointreport.txt"
  293.  nodelist "POINT4D"      diff ""         domain "fidonet"
  294.  
  295.  
  296.  password "abcdef" 39:23/5@amiganet 2:310/108@fidonet
  297.  password "bcdefg" 1:2/3.4
  298.  
  299.  ; phone number translation:
  300.  
  301.  dial    "43-222-"       ""            ;local calls
  302.  dial    "43-1-"         ""            ;local calls
  303.  dial    "43-2252-"      "905-"        ;Baden
  304.  dial    "43-5574-"      "999-"        ;Bregenz
  305.  dial    "43-2682-"      "998-"        ;Eisenstadt
  306.  dial    "43-316-"       "993-"        ;Graz
  307.  dial    "43-463-"       "994-"        ;Klagenfurt
  308.  dial    "43-732-"       "997-"        ;Linz/Donau
  309.  dial    "43-2236-"      "902-"        ;Mödling
  310.  dial    "43-662-"       "996-"        ;Salzburg Stadt
  311.  dial    "43-2742-"      "907-"        ;St. Pölten
  312.  dial    "43-2266-"      "908-"        ;Stockerau
  313.  dial    "43-2622-"      "906-"        ;Wiener Neustadt
  314.  dial    "43-"           "0"           ;Rest of Austria
  315.  dial    "352-"          "00432-"      ;Luxemburg
  316.  dial    "39-"           "040-"        ;Italy
  317.  dial    "49-"           "060-"        ;Germany
  318.  dial    "41-"           "050-"        ;Switzerland
  319.  dial    "-"             "-"           ;"-Unpublished-" unchanged
  320.  dial    ""              "00"          ;add "00" to other entries
  321.  
  322.  ;cost table:
  323.  
  324.  cost    400     "43-2212-"
  325.  cost    400     "43-2213-"
  326.  cost    400     "43-2214-"
  327.  cost    400     "43-2253-"
  328.  cost    867     "32-"
  329.  cost    867     "49-"
  330.  cost    867     "45-"
  331.  cost    1333    "358-"
  332.  cost    867     "33-"
  333.  cost    1333    "30-"
  334.  cost    1333    "44-"
  335.  cost    -1      "-"          ;-Unpublished-
  336.  cost    2800    ""           ;rest of the world
  337.  
  338.  ;custom configurations
  339.  
  340.  setconfig 39:* AFTERSESSION "s:amiganet.bat"
  341.  setconfig 40:* AFTERSESSION "s:amiganet.bat"
  342.  setconfig 41:* AFTERSESSION "s:amiganet.bat"
  343.  
  344.  ;-----------------------------------------------------------------------
  345.  
  346. 5.    GetInfo
  347.  
  348.  
  349.    Usage: GetInfo <address> [<pattern>] [<output type>]
  350.  
  351.    GetInfo can be used to obtain informations for one single node or for
  352.    a set of nodes matching the address pattern (and the text pattern).
  353.  
  354.    <pattern> will be enclosed in #? and the Dos patternmatching function
  355.    will be used. E.g to list all nodes in the nodelist containing either
  356.    'John' or 'Mike' do: "GetInfo * (John|Mike)"
  357.  
  358.    <output type> is one of a,b,c,d or e where 'a' will give most
  359.  
  360.                                   - Page 5 -
  361. 5.    GetInfo
  362.  
  363.    informations and 'e' very few. If you want to use <output type> but
  364.    not <pattern> specify "" as <pattern>.
  365.  
  366.    GetInfo needs a compiled nodelist (GList) in 'nodelist:'.
  367.  
  368.    Examples: GetInfo 1:* "John Doe"
  369.              GetInfo 2:310/*
  370.              GetInfo * "amiga"
  371.  
  372.    Press Ctrl-C to stop GetInfo.
  373.  
  374. 6.    GTell
  375.  
  376.  
  377.    GTell [<ARexx port>] <ARexx command>
  378.  
  379.    This little tool will send out <ARexx command> to <ARexx port> or if
  380.    <ARexx port> was not specified to a port called "GOTCHA".
  381.  
  382.    This is quite handy e.g. to tell Gotcha with ARexx-port "G0" to call
  383.    2:310/108 type: 'GTell G0 "call 2:310/108"'
  384.  
  385.    Or to get the current Hydra settings:
  386.    'GTell G0 "getconfig NOHYDRA"'
  387.  
  388.    If you specify '!' as <ARexx port> a requester will pop up and ask for
  389.    a port.
  390.  
  391. 7.    Address Patterns
  392.  
  393.  
  394.    Address Patterns and Wildcards
  395.  
  396.    Sometimes it is allowed to specify a pattern instead of a full address.
  397.    For those address patterns two wildcards are allowed: '*' and '?'.
  398.    '?' replaces one single item.
  399.    '*' means: assume '?' for the rest of the items.
  400.  
  401.    E.g. '2:*' would match all addresses in zone 2.
  402.         '1:?/?.0' would match all nodes in zone 1.
  403.         '?:1/?.0' would match all nodes in net 1 in all zones.
  404.         '?:?/?.0@amiganet' would match all addresses in amiganet.
  405.  
  406.    Note that domains are per default assumed to be '?'.
  407.    So 1:2/3 would match 1:2/3@abcdnet and 1:2/3@xyznet.
  408.  
  409. 8.    ShowXConfig
  410.  
  411.  
  412.    Usage: ShowXConfig <address>
  413.  
  414.    This tool will list all, or parts of, the custom configurations set with
  415.    the setconfig keyword in 'glist.config' (see GList).
  416.  
  417.    <address> may be a pattern too.
  418.  
  419.    Example: ShowXConfig *        ; shows all custom configurations
  420.             ShowXConfig 2:*      ; shows custom configs for zone 2
  421.  
  422. 9.    GPoll
  423.  
  424.  
  425.    GPoll [+/-C][+/-D][+/-N][+/-R][-O<outbound dir>][-P<port>][-A][-G]
  426.  
  427.    GPoll will scan your outbound directory for files that need to be
  428.    delivered. It will build a calling list and send it to <port> (or GOTCHA
  429.    per default), this will only work with 4D-filenames such as
  430.  
  431.                                   - Page 6 -
  432. 9.    GPoll
  433.  
  434.    '39.23.5.0.out'.
  435.  
  436.    NOTE: If you want to use this tool from within Gotcha (as a function key
  437.    command or from the ARexx sender) you MUST 'run' the program, NOT spawn
  438.    it! This is because it will send ARexx commands to Gotcha, while Gotcha
  439.    is waiting for the command to complete, the least thing that could happen
  440.    are enforcer hits, the worst a crash.
  441.  
  442.    +C or -C
  443.       Tells GPoll to (not) call nodes which have crash mail waiting
  444.    (#?.CLO, #?.CUT). Default: +C
  445.  
  446.    +D or -D
  447.       Tells GPoll to (not) call nodes which have direct mail waiting
  448.    (#?.DLO, #?.DUT). Default: -D
  449.  
  450.    +N or -N
  451.       Tells GPoll to (not) call nodes which have normal mail waiting
  452.    (#?.OUT, #?.FLO). Default -N
  453.  
  454.    +R or -R
  455.       Tells GPoll to (not) call nodes which have request mail waiting
  456.    (#?.REQ). Default: -R
  457.  
  458.    -O<outbound directory>
  459.       Specifies the outbound directory. Default: 'mail:outbound'
  460.  
  461.    -P<port>
  462.       Specifies the ARexx port name to send the call-list to.
  463.       Default: GOTCHA
  464.  
  465.    -G
  466.       This will open a GUI which allows (and requires) some interaction.
  467.  
  468.    -A
  469.       If '-G' is specified this will make GPoll open on the current active
  470.       screen.
  471.  
  472.    Example: GPoll +C -D -N -R -pGOTCHA -oMail:outbound
  473.             ;this is also the default
  474.  
  475. 10.    Trap2G
  476.  
  477.  
  478.    Usage: Trap2G <trapdoor.cfg> <gotcha.config>
  479.  
  480.    This little tool will convert TrapDoor configuration files to Gotcha
  481.    configuration files. Note that not all TD-keywords are supported but
  482.    about all that are usefull.
  483.  
  484. 11.    GFreq
  485.  
  486.  
  487.    Usage: GFReq [ACTIVE]
  488.  
  489.    This is little tool is intended to help on filerequests. If ACTIVE is
  490.    specified as a cli argument it will open its window on the active
  491.    (public) screen.
  492.  
  493.    First select an address were you want to make your filereqest, enter it
  494.    in the topmost string gadget. Then select the files you want to request.
  495.    If you click on "CALL" you will be presented a little window that should
  496.    contain the name of a ARexx port to send the call command to, select a
  497.    port and click on "CALL" to send the ARexx command or on "Cancel" to
  498.    quit.
  499.    "Save Bak" will save a backup of the filerequest. If you enter the same
  500.    address the next time and no .REQ file is found the bak file will be
  501.  
  502.                                   - Page 7 -
  503. 11.    GFreq
  504.  
  505.    loaded (and deleted from disk!).
  506.  
  507.    The best thing is to put this as an command on an function key with
  508.    a FKEY keyword. E.g. FKEY10 "spawn mail:bin/GFReq ACTIVE"
  509.  
  510. 12.    GConfig
  511.  
  512.  
  513.    GConfig is a nice little GUI driven tool that lets you edit
  514.    configurations, get configs from an running Gotcha and set configs for a
  515.    running Gotcha.
  516.  
  517.  
  518.    Once started GConfig will try to read Gotchas default config
  519.    "mail:gotcha.config". If that fails you have the choice to either quit
  520.    or use the defaults.
  521.  
  522.    If you're clever and either have a config in mail or decided to use
  523.    the defaults you'll see a nice little (well depends on your screenmode
  524.    and font ;) window with all sorts of gadgets in it.
  525.  
  526.    Well, I guess it is quite obvious what all the stuff is about so lets
  527.    have a look at the row of gadgets on the bottom of the window:
  528.  
  529.      Quit
  530.          Hmmmmmm, what do you think happens if you click this one?!?
  531.  
  532.      Get...
  533.          That's a nice one. It lets you get a config from a Gotcha that's
  534.          running at the very moment you click this button. Just choose
  535.          the ARexx port and there you go.
  536.  
  537.      Set...
  538.          That's the reverse of 'Get..'. NB: Only use this on Gotchas that
  539.          are hanging around idle. Weird things could happen else!
  540.          Some configs can NOT be changed this way (BUFFEREDLOG,ANSWER,
  541.          QUIET,REXXNAME,CX_POPKEY,CX_PRIORITY,LOGLINES), that's why there
  542.          is a * in the label name.
  543.  
  544.      Load...
  545.          If you feel the desire to edit some other config then use this.
  546.  
  547.      Save...
  548.          If you are done with your changes. It might be a good idea to save
  549.          the config.
  550.  
  551.      Help...
  552.          In case you don't know Gotcha.guide by heart (which is a shame :)
  553.          and wonder what some weird keyword does click here.
  554.  
  555. 13.    Legal Stuff
  556.  
  557.  
  558.    All Thomas Bickel products are trademarks of Thomas Bickel.
  559.    Other brand and product names are trademarks or registered trademarks of
  560.    their respective holders.
  561.  
  562.    All tools described in this documentation are (c)1995/1996 Thomas Bickel.
  563.    All rights reserved.
  564.  
  565.    The tools may be used as long as you are allowed to use Gotcha
  566.    (read the licence agreement in the Gotcha documentation!)
  567.  
  568.    The same licence agreement as for Gotcha applies.
  569.  
  570.    Have a look at the Gotcha documentation for more legal information.
  571.  
  572.  
  573.                                   - Page 8 -
  574. 13.    Legal Stuff
  575.  
  576.  
  577.    DISCLAIMER
  578.  
  579.      Each tool is provided "as is", without warranty of any kind or fitness
  580.    for a particular purpose, either expressed or implied, all of which are
  581.    hereby explicitly disclaimed. The author only guarantees that the tools
  582.    will occupy disk space.
  583.    In no event shall the author be liable to you or anyone else for any
  584.    damages, including any lost profits, lost savings or other incidental or
  585.    consequential damages arising out of the use or inability to use this
  586.    software.
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.                                   - Page 9 -
  645. 13.    Legal Stuff
  646.  
  647.  
  648. 14.    INDEX of sections
  649.  
  650. Address Patterns ...................................................   5. 27
  651. GConfig ............................................................   7.  4
  652. GetInfo ............................................................   4. 53
  653. GFreq ..............................................................   6. 49
  654. GList ..............................................................   1. 21
  655. GList Basics .......................................................   1. 29
  656. GList Usage ........................................................   1. 52
  657. Gotcha Tools Documentation .........................................   1.  0
  658. GPoll ..............................................................   5. 58
  659. GTell ..............................................................   5. 10
  660. Legal Stuff ........................................................   7. 49
  661. ShowXConfig ........................................................   5. 45
  662. Trap2G .............................................................   6. 40
  663.  
  664. 15.    INDEX of keywords
  665.  
  666. address pattern ....................................................   4. 60
  667. address-pattern ....................................................   3. 27
  668. Basics        ......................................................   1. 27
  669. GConfig         ....................................................   1. 18
  670. GetInfo         ....................................................   1. 12
  671. GFReq           ....................................................   1. 17
  672. GList ..............................................................   5.  3
  673. GList           ....................................................   1. 11
  674. GPoll           ....................................................   1. 15
  675. GTell           ....................................................   1. 13
  676. Legal stuff ........................................................   1. 20
  677. pattern ............................................................   5. 54
  678. ShowXConfig     ....................................................   1. 14
  679. Trap2G          ....................................................   1. 16
  680. Usage         ......................................................   1. 28
  681.